Fix device client type, update READMEs and e2e apps#543
Fix device client type, update READMEs and e2e apps#543
Conversation
📝 WalkthroughWalkthroughThis pull request adds type annotations across e2e test applications and package files, makes the realm property optional in the device profile types, updates import patterns in documentation, and introduces a changeset entry documenting the realm change for the device-client package. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🦋 Changeset detectedLatest commit: 7bd1377 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
View your CI Pipeline Execution ↗ for commit 7bd1377
☁️ Nx Cloud last updated this comment at |
@forgerock/davinci-client
@forgerock/device-client
@forgerock/journey-client
@forgerock/oidc-client
@forgerock/protect
@forgerock/sdk-types
@forgerock/sdk-utilities
@forgerock/iframe-manager
@forgerock/sdk-logger
@forgerock/sdk-oidc
@forgerock/sdk-request-middleware
@forgerock/storage
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (14.75%) is below the target coverage (40.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #543 +/- ##
==========================================
- Coverage 18.79% 14.75% -4.05%
==========================================
Files 140 153 +13
Lines 27640 26265 -1375
Branches 980 1054 +74
==========================================
- Hits 5195 3875 -1320
+ Misses 22445 22390 -55
🚀 New features to boost your workflow:
|
|
Deployed cd0a89f to https://ForgeRock.github.io/ping-javascript-sdk/pr-543/cd0a89fb9792555f580f0ee8046d5a7bbf75acc0 branch gh-pages in ForgeRock/ping-javascript-sdk |
📦 Bundle Size Analysis📦 Bundle Size Analysis🆕 New Packages🆕 @forgerock/journey-client - 87.3 KB (new) 📊 Minor Changes📈 @forgerock/device-client - 9.2 KB (+0.0 KB) ➖ No Changes➖ @forgerock/sdk-logger - 1.6 KB 13 packages analyzed • Baseline from latest Legend🆕 New package ℹ️ How bundle sizes are calculated
🔄 Updated automatically on each push to this PR |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/oidc-client/README.md (1)
19-35:⚠️ Potential issue | 🟡 MinorFix the
token.exchangequickstart call signature.The quickstart shows passing a single object, but the API expects positional
codeandstatearguments as per the actual implementation.📘 Suggested README fix
-const newTokens = await oidcClient.token.exchange({ - /* code, state */ -}); // Returns new tokens or error +const code = '...'; +const state = '...'; +const newTokens = await oidcClient.token.exchange(code, state); // Returns new tokens or error🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/oidc-client/README.md` around lines 19 - 35, The README example incorrectly calls oidcClient.token.exchange with a single object; update the quickstart to call the actual implementation signature by passing code and state as positional arguments to oidcClient.token.exchange (e.g., call exchange(code, state)), and update the surrounding comment to reflect it returns new tokens or an error; locate the example block using the symbol oidcClient.token.exchange and replace the single-object call with the positional-argument form.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@packages/oidc-client/README.md`:
- Around line 19-35: The README example incorrectly calls
oidcClient.token.exchange with a single object; update the quickstart to call
the actual implementation signature by passing code and state as positional
arguments to oidcClient.token.exchange (e.g., call exchange(code, state)), and
update the surrounding comment to reflect it returns new tokens or an error;
locate the example block using the symbol oidcClient.token.exchange and replace
the single-object call with the positional-argument form.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.changeset/soft-moose-read.mde2e/davinci-app/components/fido.tse2e/device-client-app/src/utils/index.tse2e/oidc-app/src/utils/oidc-app.tse2e/protect-app/src/protect-native.tspackages/device-client/README.mdpackages/device-client/src/lib/types/profile-device.types.tspackages/journey-client/README.mdpackages/oidc-client/README.md
2 participants
JIRA Ticket
https://pingidentity.atlassian.net/browse/SDKS-4816
Description
Summary by CodeRabbit
New Features
Documentation